Pagination

interface Pagination : ClosedRange<Int>

Base interface of pagination

If you want to request something, you should use SimplePagination. If you need to return some result including pagination - PaginationResult

Functions

contains

jvm

open operator fun contains(value: Int): Boolean

isEmpty

jvm

open fun isEmpty(): Boolean

Properties

endInclusive

jvm

open override val endInclusive: Int

page

jvm

abstract val page: Int

Started with 0. Number of page inside of pagination. Offset can be calculated as page * size

size

jvm

abstract val size: Int

Can be 0, but can't be < 0 Size of current page. Offset can be calculated as page * size

start

jvm

open override val start: Int

Inheritors

PaginationResult

SimplePagination

Extensions

asUrlQueryArrayParts

val Pagination.asUrlQueryArrayParts: Array<Pair<String, String>>

val Pagination.asUrlQueryArrayParts: Array<Pair<String, String>>

val Pagination.asUrlQueryArrayParts: Array<Pair<String, String>>

asUrlQueryParts

val Pagination.asUrlQueryParts: Map<String, String>

val Pagination.asUrlQueryParts: Map<String, String>

val Pagination.asUrlQueryParts: Map<String, String>

firstIndex

val Pagination.firstIndex: Int

val Pagination.firstIndex: Int

val Pagination.firstIndex: Int

First number in index of objects. It can be used as offset for databases or other data sources

intersect

fun Pagination.intersect(other: Pagination): Pagination?

fun Pagination.intersect(other: Pagination): Pagination?

fun Pagination.intersect(other: Pagination): Pagination?

isFirstPage

val Pagination.isFirstPage: Boolean

val Pagination.isFirstPage: Boolean

val Pagination.isFirstPage: Boolean

Logical shortcut for comparison that page is 0

lastIndex

android

val Pagination.lastIndex: Int

Last number in index of objects. In fact, one Pagination object represent data in next range:

common

val Pagination.lastIndex: Int

Last number in index of objects. In fact, one Pagination object represent data in next range:

jvm

val Pagination.lastIndex: Int

Last number in index of objects. In fact, one Pagination object represent data in next range:

lastIndexExclusive

android

val Pagination.lastIndexExclusive: Int

Last number in index of objects. In fact, one Pagination object represent data in next range:

common

val Pagination.lastIndexExclusive: Int

Last number in index of objects. In fact, one Pagination object represent data in next range:

jvm

val Pagination.lastIndexExclusive: Int

Last number in index of objects. In fact, one Pagination object represent data in next range:

limitClause

android

fun Pagination.limitClause(): String

nextPage

inline fun Pagination.nextPage(): SimplePagination

inline fun Pagination.nextPage(): SimplePagination

inline fun Pagination.nextPage(): SimplePagination

reverse

fun Pagination.reverse(datasetSize: Long): SimplePagination

fun Pagination.reverse(datasetSize: Long): SimplePagination

fun Pagination.reverse(datasetSize: Long): SimplePagination

Example:

android

fun Pagination.reverse(objectsCount: Int): SimplePagination

Shortcut for reverse

common

fun Pagination.reverse(objectsCount: Int): SimplePagination

Shortcut for reverse

jvm

fun Pagination.reverse(objectsCount: Int): SimplePagination

Shortcut for reverse